

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Python Module Index &mdash; L5Kit 1.0.0 documentation</title>
  

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  
  
  

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
 


</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home" alt="Documentation Home"> L5Kit
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">ML Prediction, Planning and Simulation for Self-Driving</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#examples">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#news">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#overview">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#license">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#credits">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#contact">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_format.html">Dataset Formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_contribute.html">How to contribute</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">L5Kit</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Python Module Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

   <h1>Python Module Index</h1>

   <div class="modindex-jumpbox">
   <a href="#cap-l"><strong>l</strong></a>
   </div>

   <table class="indextable modindextable">
     <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
     <tr class="cap" id="cap-l"><td></td><td>
       <strong>l</strong></td><td></td></tr>
     <tr>
       <td><img src="_static/minus.png" class="toggler"
              id="toggle-1" style="display: none" alt="-" /></td>
       <td>
       <a href="API/l5kit.html#module-l5kit"><code class="xref">l5kit</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.configs.html#module-l5kit.configs"><code class="xref">l5kit.configs</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.configs.config.html#module-l5kit.configs.config"><code class="xref">l5kit.configs.config</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.html#module-l5kit.data"><code class="xref">l5kit.data</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.combine.html#module-l5kit.data.combine"><code class="xref">l5kit.data.combine</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.filter.html#module-l5kit.data.filter"><code class="xref">l5kit.data.filter</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.labels.html#module-l5kit.data.labels"><code class="xref">l5kit.data.labels</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.local_data_manager.html#module-l5kit.data.local_data_manager"><code class="xref">l5kit.data.local_data_manager</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.map.html#module-l5kit.data.map"><code class="xref">l5kit.data.map</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.proto.html#module-l5kit.data.proto"><code class="xref">l5kit.data.proto</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.proto.road_network_pb2.html#module-l5kit.data.proto.road_network_pb2"><code class="xref">l5kit.data.proto.road_network_pb2</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.data.zarr_dataset.html#module-l5kit.data.zarr_dataset"><code class="xref">l5kit.data.zarr_dataset</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.dataset.html#module-l5kit.dataset"><code class="xref">l5kit.dataset</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.dataset.agent.html#module-l5kit.dataset.agent"><code class="xref">l5kit.dataset.agent</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.dataset.dataloader_builder.html#module-l5kit.dataset.dataloader_builder"><code class="xref">l5kit.dataset.dataloader_builder</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.dataset.ego.html#module-l5kit.dataset.ego"><code class="xref">l5kit.dataset.ego</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.dataset.select_agents.html#module-l5kit.dataset.select_agents"><code class="xref">l5kit.dataset.select_agents</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.evaluation.html#module-l5kit.evaluation"><code class="xref">l5kit.evaluation</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.evaluation.extract_ground_truth.html#module-l5kit.evaluation.extract_ground_truth"><code class="xref">l5kit.evaluation.extract_ground_truth</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.evaluation.extract_losses.html#module-l5kit.evaluation.extract_losses"><code class="xref">l5kit.evaluation.extract_losses</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.evaluation.write_csv.html#module-l5kit.evaluation.write_csv"><code class="xref">l5kit.evaluation.write_csv</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.geometry.html#module-l5kit.geometry"><code class="xref">l5kit.geometry</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.geometry.angle.html#module-l5kit.geometry.angle"><code class="xref">l5kit.geometry.angle</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.geometry.image.html#module-l5kit.geometry.image"><code class="xref">l5kit.geometry.image</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.geometry.transform.html#module-l5kit.geometry.transform"><code class="xref">l5kit.geometry.transform</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.geometry.voxel.html#module-l5kit.geometry.voxel"><code class="xref">l5kit.geometry.voxel</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.kinematic.html#module-l5kit.kinematic"><code class="xref">l5kit.kinematic</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.kinematic.ackerman_perturbation.html#module-l5kit.kinematic.ackerman_perturbation"><code class="xref">l5kit.kinematic.ackerman_perturbation</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.kinematic.ackerman_steering_model.html#module-l5kit.kinematic.ackerman_steering_model"><code class="xref">l5kit.kinematic.ackerman_steering_model</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.kinematic.perturbation.html#module-l5kit.kinematic.perturbation"><code class="xref">l5kit.kinematic.perturbation</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.random.html#module-l5kit.random"><code class="xref">l5kit.random</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.random.random_generator.html#module-l5kit.random.random_generator"><code class="xref">l5kit.random.random_generator</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.html#module-l5kit.rasterization"><code class="xref">l5kit.rasterization</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.box_rasterizer.html#module-l5kit.rasterization.box_rasterizer"><code class="xref">l5kit.rasterization.box_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.combine_rasterizer.html#module-l5kit.rasterization.combine_rasterizer"><code class="xref">l5kit.rasterization.combine_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.rasterizer.html#module-l5kit.rasterization.rasterizer"><code class="xref">l5kit.rasterization.rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.rasterizer_builder.html#module-l5kit.rasterization.rasterizer_builder"><code class="xref">l5kit.rasterization.rasterizer_builder</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.sat_box_rasterizer.html#module-l5kit.rasterization.sat_box_rasterizer"><code class="xref">l5kit.rasterization.sat_box_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.satellite_image.html#module-l5kit.rasterization.satellite_image"><code class="xref">l5kit.rasterization.satellite_image</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.satellite_rasterizer.html#module-l5kit.rasterization.satellite_rasterizer"><code class="xref">l5kit.rasterization.satellite_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.sem_box_rasterizer.html#module-l5kit.rasterization.sem_box_rasterizer"><code class="xref">l5kit.rasterization.sem_box_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.semantic_rasterizer.html#module-l5kit.rasterization.semantic_rasterizer"><code class="xref">l5kit.rasterization.semantic_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.rasterization.stub_rasterizer.html#module-l5kit.rasterization.stub_rasterizer"><code class="xref">l5kit.rasterization.stub_rasterizer</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.sampling.html#module-l5kit.sampling"><code class="xref">l5kit.sampling</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.sampling.agent_sampling.html#module-l5kit.sampling.agent_sampling"><code class="xref">l5kit.sampling.agent_sampling</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.sampling.slicing.html#module-l5kit.sampling.slicing"><code class="xref">l5kit.sampling.slicing</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.visualization.html#module-l5kit.visualization"><code class="xref">l5kit.visualization</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.visualization.gif.html#module-l5kit.visualization.gif"><code class="xref">l5kit.visualization.gif</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.visualization.utils.html#module-l5kit.visualization.utils"><code class="xref">l5kit.visualization.utils</code></a></td><td>
       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;
       <a href="API/l5kit.visualization.video.html#module-l5kit.visualization.video"><code class="xref">l5kit.visualization.video</code></a></td><td>
       <em></em></td></tr>
   </table>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        
        &copy; Copyright 2020, Lyft Level 5

    </p>
  </div>
    
    
    
    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>